NHS 111
Domain Message Specification

RepeatCallerQuery Tabular View

QUPA_RM000001GB01
RepeatCallerQuery
This message is a query to the Repeat Caller service to ascertain whether the NHS111 patient is a repeat caller to the NHS111 service
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CACT" }
Model Attribute Description

The HL7 attribute classCode describes this class as a control act.

Implementation in XML Instance

The XML attribute classCode is fixed to " CACT ".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }
Model Attribute Description

The HL7 attribute moodCode describes this class as an event.

Implementation in XML Instance

The XML attribute moodCode is fixed to " EVN ".
[1..1] [M] code (CV { CNE:NHS111MessageType } )
{ Fixed="01" }

Model Attribute Description

The HL7 attribute code uses a code from the NHS111MessageType vocabulary to describe this message as a repeat caller service query message.

Implementation in XML Instance

The Coded with Code System flavour of Coded Value (CV) data type shall be used to carry this in the XML element code information as follows:

  • The XML attribute code shall contain " 01 "
  • The XML attribute codeSystem shall contain the OID " 2.16.840.1.113883.2.1.3.2.4.17.420 "
[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to define when the query to the repeat caller service was made.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time the query to the repeat caller service was made using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes
[1..1] [M] id (II)
Model Attribute Description

The HL7 attribute id holds a unique identifier for this control act event.

Implementation in XML Instance

The XML element id is populated with a generated DCE UUID in the following way:
  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] query (Query)
A link to the query parameters
[1..1] [M] author
This class links the repeat caller service query to author of the query.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as an author participation.

Implementation in XML Instance

The XML attribute classCode is fixed to " AUT ".

[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description
The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the query are conducted across to the child classes (also associated with the child classes). This set of codes also determines how these participations conduct.

The conduction can only take place if the contextConductionInd is set to " true "

The value of this attribute is fixed in the HL7 model to " OP "

  • " O " (Overriding)- the author replaces any author that has been conducted from any previous acts.
  • " P " (Propagating)- the author is conducted to all child acts where the contextConductionInd is set to " true ".

Implementation in XML Instance
The XML attribute contextControlCode is fixed to " OP "

[1..1] [M] contentId (II) { "NPFIT-100033#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance


The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID " 2.16.840.1.113883.2.1.3.2.4.18.16 "
  • The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] participant (AuthorChoice)
A link to a choice of authors.
[0..1] pertinentInformation

This class is a relationship of pertinent information.

It is used to carry the Permission To View outcome.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="PERT" }

Model Attribute Description

The HL7 attribute typeCode describes this class as one of pertinent information.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "PERT".
[1..1] [M] contentId (II) { "NPFIT-300007#Act" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] pertinentPermissionToViewChoice (PermissionToViewChoice)
A link to the choice of permission to view templates.
Query
A container for all the query parameters
Used by: RepeatCallerQuery
[0..1] person.birthTime (Person.birthTime)
A link to the query parameter representing the patient's date of birth
[0..1] person.familyName (Person.familyName)
A link to the query parameter representing the patient's family name
[0..1] person.givenName (Person.givenName)
A link to the query parameter representing the patient's given name
[0..1] person.id (Person.id)
A link to the query parameter representing the patient's NHS Number
[0..1] person.postalCode (Person.postalCode)
A link to the query parameter representing the patient's post code
[0..1] person.streetAddressLine1 (Person.streetAddressLine1)
A link to the query parameter representing the patient's street address line 1
Person.id
Query parameter: NHS Number of the patient
Used by: Query
[1..1] [M] semanticsText (ST)
{ Fixed="Person.id" }

Model Attribute Description

A literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText is fixed to " Person.id"
[1..1] [M] value (II)

Model Attribute Description

The value of the parameter item.

Implementation in XML Instance

The XML element value shall be used to carry the patient's NHS Number as follows:

  • The XML attribute root of the XML element value shall contain the OID "2.16.840.1.113883.2.1.4.1"
  • The XML attribute extension of the XML element value shall contain the patient's NHS Number

Person.givenName
Query parameter: given name of the patient
Used by: Query
[1..1] [M] semanticsText (ST)
{ Fixed="Person.givenName" }

Model Attribute Description

A literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText is fixed to "Person.givenName"

[1..1] [M] value (ST)

Model Attribute Description

The value of the parameter item.

Implementation in XML Instance

The XML element value shall contain the patient's given name


Person.streetAddressLine1
Query parameter: first address line of the patient
Used by: Query
[1..1] [M] semanticsText (ST)
{ Fixed="Person.streetAddressLine1" }

Model Attribute Description

A literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText is fixed to " Person.streetAddressLine1"
[1..1] [M] value (ST)

Model Attribute Description

The value of the parameter item.

Implementation in XML Instance

The XML element value shall contain the patient's first address line


Person.familyName
Query parameter : family name of the patient
Used by: Query
[1..1] [M] semanticsText (ST)
{ Fixed="Person.familyName" }

Model Attribute Description

A literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText is fixed to " Person.familyName"
[1..1] [M] value (ST)

Model Attribute Description

The value of the parameter item.

Implementation in XML Instance

The XML element value shall contain the patient's family name
Person.birthTime
Query parameter: date of birth of the patient
Used by: Query
[1..1] [M] semanticsText (ST)
{ Fixed="Person.birthTime" }

Model Attribute Description

A literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText is fixed to "Person.birthTime"

[1..1] [M] value (TS)

Model Attribute Description

The value of the parameter item.

Implementation in XML Instance

The XML attribute value of the XML element value shall contain the date of birth of the patient in the format format yyyymmdd where:
  • yyyy is the year
  • mm is the month
  • dd is the day
Person.postalCode
Query parameter: post code of the patient r
Used by: Query
[1..1] [M] semanticsText (ST)
{ Fixed="Person.postalCode" }

Model Attribute Description

A literal text string identifying the parameter item.

Implementation in XML Instance

The XML element semanticsText is fixed to " Person.postalCode"
[1..1] [M] value (ST)

Model Attribute Description

The value of the parameter item.

Implementation in XML Instance

The XML element value shall contain the patient's post code


AuthorChoice
An abstract placeholder for the template choice for an author
Used by: RepeatCallerQuery
[1..1] : Template1
PermissionToViewChoice
An abstract placeholder for the template choice for a permission to view outcome.
Used by: RepeatCallerQuery
[1..1] : Template2